home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmTextGetSubstringWcs.z / XmTextGetSubstringWcs
Encoding:
Text File  |  2002-10-03  |  5.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss - A Text function that retrieves a
  10.           portion of a wide character internal text buffer
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////TTTTeeeexxxxtttt....hhhh>>>>
  14.  
  15.           iiiinnnntttt XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss ((((_w_i_d_g_e_t, _s_t_a_r_t, _n_u_m__c_h_a_r_s, _b_u_f_f_e_r__s_i_z_e, _b_u_f_f_e_r))))
  16.                WWWWiiiiddddggggeeeetttt      _w_i_d_g_e_t;;;;
  17.                XXXXmmmmTTTTeeeexxxxttttPPPPoooossssiiiittttiiiioooonnnn_s_t_a_r_t;;;;
  18.                iiiinnnntttt         _n_u_m__c_h_a_r_s;;;;
  19.                iiiinnnntttt         _b_u_f_f_e_r__s_i_z_e;;;;
  20.                wwwwcccchhhhaaaarrrr____tttt     ****_b_u_f_f_e_r;;;;
  21.  
  22.  
  23.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  24.           This page documents version 1.2 of the Motif library.
  25.  
  26.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.           XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss retrieves a copy of a portion of the
  28.           internal text buffer of a Text widget that is stored in a
  29.           wide character format.  The function copies a specified
  30.           number of characters from a given start position in the
  31.           internal text buffer into a buffer provided by the
  32.           application.  A NULL terminator is placed at the end of the
  33.           copied data.
  34.  
  35.  
  36.           _w_i_d_g_e_t    Specifies the Text widget ID.
  37.  
  38.           _s_t_a_r_t     Specifies the beginning character position from
  39.                     which the data will be retrieved.  This is an
  40.                     integer number of characters from the beginning of
  41.                     the text buffer.  The first character position is
  42.                     0.
  43.  
  44.           _n_u_m__c_h_a_r_s Specifies the number of wwwwcccchhhhaaaarrrr____tttt characters to be
  45.                     copied into the provided buffer.
  46.  
  47.           _b_u_f_f_e_r__s_i_z_e
  48.                     Specifies the size of the supplied buffer as a
  49.                     number of wwwwcccchhhhaaaarrrr____tttt storage locations.  The minimum
  50.                     size is _n_u_m__c_h_a_r_s + 1.
  51.  
  52.           _b_u_f_f_e_r    Specifies the wide character buffer into which the
  53.                     internal text buffer will be copied.
  54.  
  55.  
  56.           For a complete definition of Text and its associated
  57.           resources, see XXXXmmmmTTTTeeeexxxxtttt((((3333XXXX)))).
  58.  
  59.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  60.  
  61.  
  62.  
  63.      PPPPaaaaggggeeee 1111                                          ((((pppprrrriiiinnnntttteeeedddd 4444////33330000////99998888))))
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           XXXXmmmmCCCCOOOOPPPPYYYY____SSSSUUUUCCCCCCCCEEEEEEEEDDDDEEEEDDDD    The function was successful.
  75.  
  76.           XXXXmmmmCCCCOOOOPPPPYYYY____FFFFAAAAIIIILLLLEEEEDDDD       The function failed because it was
  77.                               unable to copy the specified number of
  78.                               characters into the buffer provided.
  79.                               The buffer size may be insufficient.
  80.                               The contents of _b_u_f_f_e_r are undefined.
  81.  
  82.           XXXXmmmmCCCCOOOOPPPPYYYY____TTTTRRRRUUUUNNNNCCCCAAAATTTTEEEEDDDD    The requested number of characters
  83.                               extended beyond the internal buffer.
  84.                               The function copied characters between
  85.                               _s_t_a_r_t and the end of the widget's buffer
  86.                               and terminated the string with a NULL
  87.                               terminator; fewer than _n_u_m__c_h_a_r_s
  88.                               characters were copied.
  89.  
  90.  
  91.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  92.           XXXXmmmmTTTTeeeexxxxtttt((((3333XXXX)))) and XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg((((3333XXXX)))).
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.